📖 Bundle Deployment Configuration by anik120 · Pull Request #2528 · operator-framework/operator-controller

anik120 · 2026-02-25T20:36:22Z

Description

Adds user-facing documentation for the Bundle Deployment Configuration feature,
which provides feature parity with OLM v0's Subscription.spec.config (SubscriptionConfig).

What's included:

How to enable the DeploymentConfig feature gate
Complete configuration reference for all deployment customization options:
- Environment variables (env, envFrom)
- Resource requirements (resources)
- Node placement (nodeSelector, tolerations, affinity)
- Storage (volumes, volumeMounts)
- Annotations
Migration guide from OLM v0's SubscriptionConfig to OLM v1
Validation details including how the JSON schema is generated for registry+v1 bundles
Troubleshooting and verification steps

Related work:

RFC: Deployment Configuration (achieving feature parity with OLMv0's SubscriptionConfig)
Implementation:
- ✨ Add automated schema generation and validation for registry+v1 bundle configuration #2454 (schema generation and validation)
- ✨Add DeploymentConfig support to registry+v1 bundle renderer #2469 (renderer support)
- ✨Extract and pass deploymentConfig to bundle renderer #2482 (controller integration)
- ✨ Add feature gate for registry+v1 bundle deploymentConfig #2527 (DeploymentConfig feature gate)

This documentation is placed in docs/draft/howto/ as the feature is currently experimental
and requires the DeploymentConfig feature gate to be enabled.

Reviewer Checklist

API Go Documentation
Tests: Unit Tests (and E2E Tests, if appropriate)
Comprehensive Commit Messages
Links to related GitHub Issue(s)

netlify · 2026-02-25T20:36:27Z

✅ Deploy Preview for olmv1 ready!

Name	Link
🔨 Latest commit	`e2935d0`
🔍 Latest deploy log	https://app.netlify.com/projects/olmv1/deploys/69a5ed23f7f40e0008231d7e
😎 Deploy Preview	https://deploy-preview-2528--olmv1.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copilot

Pull request overview

This pull request adds comprehensive documentation for the Bundle Deployment Configuration feature, which enables users to customize operator deployment settings in OLMv1. The feature provides parity with OLMv0's Subscription.spec.config functionality, allowing customization of resource requirements, node placement, environment variables, storage, and annotations.

Changes:

Added detailed documentation explaining the Bundle Deployment Configuration feature and its use cases
Provided configuration examples for environment variables, resources, node placement (selectors, tolerations, affinity), storage, and annotations
Included migration guide from OLM v0 to OLM v1
Documented validation schema generation and error handling

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-25T20:42:34Z

docs/draft/howto/customize-operator-deployments.md

+config:
+  inline:


The config examples are missing the required configType field. According to the ClusterExtension API definition (api/v1/clusterextension_types.go), the config.configType field is required and must be set to "Inline" when using inline configuration. All examples should include configType: Inline before the inline: field.

Copilot · 2026-02-25T20:42:34Z

docs/draft/howto/customize-operator-deployments.md

+  config:
+    env:


The config examples are missing the required configType field. According to the ClusterExtension API definition (api/v1/clusterextension_types.go), the config.configType field is required and must be set to "Inline" when using inline configuration. All examples should include configType: Inline before the inline: field.

Copilot · 2026-02-25T20:42:35Z

docs/draft/howto/customize-operator-deployments.md

+        custom.annotation/key: "value"
+```
+
+**Behavior**: Annotations are merged with existing annotations. If the same annotation key exists in both the bundle and the configuration, the bundle's annotation value takes precedence.


The behavior description for annotations is incorrect. According to the implementation in internal/operator-controller/rukpak/render/registryv1/generators/generators.go lines 772-796, existing deployment and pod annotations take precedence over config annotations (no override). The documentation states the opposite - that "the bundle's annotation value takes precedence". The correct behavior is that annotations from the bundle are NOT overridden by the deploymentConfig annotations.

Suggested change

**Behavior**: Annotations are merged with existing annotations. If the same annotation key exists in both the bundle and the configuration, the bundle's annotation value takes precedence.

**Behavior**: Annotations are merged with existing annotations. If the same annotation key exists in both the bundle and the `deploymentConfig`, the existing annotation from the bundle is preserved and the `deploymentConfig` value is ignored.

Copilot · 2026-02-25T20:42:35Z

docs/draft/howto/customize-operator-deployments.md

+config:
+  inline:


The config examples are missing the required configType field. According to the ClusterExtension API definition (api/v1/clusterextension_types.go), the config.configType field is required and must be set to "Inline" when using inline configuration. All examples should include configType: Inline before the inline: field.

Copilot · 2026-02-25T20:42:35Z

docs/draft/howto/customize-operator-deployments.md

+    catalog:
+      packageName: my-operator
+      channel: stable
+  config:


The config examples are missing the required configType field. According to the ClusterExtension API definition (api/v1/clusterextension_types.go), the config.configType field is required and must be set to "Inline" when using inline configuration. All examples should include configType: Inline before the inline: field.

Suggested change

config:

config:

configType: Inline

Copilot · 2026-02-25T20:42:37Z

docs/draft/howto/customize-operator-deployments.md

+config:
+  inline:


The config examples are missing the required configType field. According to the ClusterExtension API definition (api/v1/clusterextension_types.go), the config.configType field is required and must be set to "Inline" when using inline configuration. All examples should include configType: Inline before the inline: field.

Copilot · 2026-02-25T20:42:37Z

docs/draft/howto/customize-operator-deployments.md

+    catalog:
+      packageName: production-operator
+      version: 1.2.3
+  config:


The config examples are missing the required configType field. According to the ClusterExtension API definition (api/v1/clusterextension_types.go), the config.configType field is required and must be set to "Inline" when using inline configuration. All examples should include configType: Inline before the inline: field.

Suggested change

config:

config:

configType: Inline

Copilot · 2026-02-25T20:42:37Z

docs/draft/howto/customize-operator-deployments.md

+!!! note
+    This feature is still in `alpha` and the `DeploymentConfig` feature gate must be enabled to make use of it.
+    See the instructions below on how to enable it.


The note incorrectly states that the DeploymentConfig feature gate must be enabled. No such feature gate exists in the codebase (verified in internal/operator-controller/features/features.go). The deploymentConfig functionality appears to be available by default without any feature gate requirement.

Copilot · 2026-02-25T20:42:37Z

docs/draft/howto/customize-operator-deployments.md

+## Enabling the Feature Gate
+
+To enable the Bundle Deployment Configuration feature gate, you need to patch the `operator-controller-controller-manager` deployment in the `olmv1-system` namespace. This will add the `--feature-gates=DeploymentConfig=true` argument to the manager container.
+
+1. **Patch the deployment:**
+
+    ```bash
+    kubectl patch deployment -n olmv1-system operator-controller-controller-manager --type='json' -p='[{"op": "add", "path": "/spec/template/spec/containers/0/args/-", "value": "--feature-gates=DeploymentConfig=true"}]'
+    ```
+
+2. **Wait for the controller manager pods to be ready:**
+
+    ```bash
+    kubectl -n olmv1-system wait --for=condition=ready pods -l app.kubernetes.io/name=operator-controller
+    ```
+
+Once the above wait condition is met, the `DeploymentConfig` feature gate should be enabled in operator-controller.


The documentation incorrectly states that a DeploymentConfig feature gate must be enabled. After reviewing the codebase, no such feature gate exists in internal/operator-controller/features/features.go. The deploymentConfig functionality appears to be always available in the registry+v1 bundle config schema (internal/operator-controller/rukpak/bundle/registryv1.go) without any feature gate requirement. This entire section about enabling the feature gate should be removed or corrected.

Copilot · 2026-02-25T20:42:38Z

docs/draft/howto/customize-operator-deployments.md

+
+## Migration from OLM v0
+
+If you're migrating from OLM v0, you can directly transfer your `Subscription.spec.config` settings to the `deploymentConfig` object within `ClusterExtension.spec.config.inline`. The structure is identical.


The statement "The structure is identical" could be clearer. While the structure of the configuration fields (env, resources, etc.) is identical, the location differs: in OLM v0 these fields are directly under Subscription.spec.config, whereas in OLM v1 they're nested under ClusterExtension.spec.config.inline.deploymentConfig. Consider rephrasing to: "The structure of the configuration fields is identical - simply nest your Subscription.spec.config settings under the deploymentConfig key within ClusterExtension.spec.config.inline."

Suggested change

If you're migrating from OLM v0, you can directly transfer your `Subscription.spec.config` settings to the `deploymentConfig` object within `ClusterExtension.spec.config.inline`. The structure is identical.

If you're migrating from OLM v0, the structure of the configuration fields is identical — simply nest your `Subscription.spec.config` settings under the `deploymentConfig` key within `ClusterExtension.spec.config.inline`.

codecov · 2026-02-25T20:56:41Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 68.59%. Comparing base (dfd25de) to head (e2935d0).
⚠️ Report is 9 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2528      +/-   ##
==========================================
- Coverage   72.04%   68.59%   -3.46%     
==========================================
  Files         103      131      +28     
  Lines        8690     9288     +598     
==========================================
+ Hits         6261     6371     +110     
- Misses       1946     2432     +486     
- Partials      483      485       +2

Flag	Coverage Δ
e2e	`42.34% <ø> (-2.99%)`	⬇️
experimental-e2e	`51.86% <ø> (-1.77%)`	⬇️
unit	`53.70% <ø> (-3.44%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

perdasilva · 2026-03-02T12:46:57Z

docs/draft/howto/customize-operator-deployments.md

+## Description
+
+!!! note
+    This feature is still in `alpha` and the `DeploymentConfig` feature gate must be enabled to make use of it.


Do we use the alpha verbiage? Or is it experimental?

Changed it to experimental

perdasilva · 2026-03-02T12:49:04Z

/lgtm

We should probably ask @michaelryanpeter to 👀 too

perdasilva · 2026-03-02T12:49:25Z

A PR description would be nice =D

Adds user-facing documentation for the Bundle Deployment Configuration feature, which provides feature parity with OLM v0's `Subscription.spec.config` (SubscriptionConfig). **What's included:** - How to enable the `DeploymentConfig` feature gate - Complete configuration reference for all deployment customization options: - Environment variables (`env`, `envFrom`) - Resource requirements (`resources`) - Node placement (`nodeSelector`, `tolerations`, `affinity`) - Storage (`volumes`, `volumeMounts`) - Annotations - Migration guide from OLM v0's SubscriptionConfig to OLM v1 - Validation details including how the JSON schema is generated for registry+v1 bundles - Troubleshooting and verification steps **Related work:** - RFC: [Deployment Configuration (achieving feature parity with OLMv0's SubscriptionConfig)](https://docs.google.com/document/d/18O4qBvu5I4WIJgo5KU1opyUKcrfgk64xsI3tyXxmVEU/edit?usp=sharing) - Implementation: - operator-framework#2454 (schema generation and validation) - operator-framework#2469 (renderer support) - operator-framework#2482 (controller integration) - operator-framework#2527 (DeploymentConfig feature gate) This documentation is placed in `docs/draft/howto/` as the feature is currently `experimental` and requires the `DeploymentConfig` feature gate to be enabled.

anik120 · 2026-03-02T20:04:37Z

Added PR description.

tmshort · 2026-03-02T20:05:52Z

/lgtm
/approve

openshift-ci · 2026-03-02T20:06:00Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: tmshort

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~docs/draft/OWNERS~~ [tmshort]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Copilot AI review requested due to automatic review settings February 25, 2026 20:36

openshift-ci bot requested review from bentito and rashmigottipati February 25, 2026 20:36

Copilot started reviewing on behalf of anik120 February 25, 2026 20:36 View session

Copilot AI reviewed Feb 25, 2026

View reviewed changes

perdasilva reviewed Mar 2, 2026

View reviewed changes

openshift-ci bot assigned perdasilva Mar 2, 2026

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Mar 2, 2026

anik120 force-pushed the deploymentconfig-docs branch from 86ce4b8 to e2935d0 Compare March 2, 2026 20:03

openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Mar 2, 2026

openshift-ci bot assigned tmshort Mar 2, 2026

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Mar 2, 2026

openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 2, 2026

openshift-merge-bot bot merged commit a9a9b40 into operator-framework:main Mar 2, 2026
27 checks passed

	Behavior: Annotations are merged with existing annotations. If the same annotation key exists in both the bundle and the configuration, the bundle's annotation value takes precedence.
	Behavior: Annotations are merged with existing annotations. If the same annotation key exists in both the bundle and the `deploymentConfig`, the existing annotation from the bundle is preserved and the `deploymentConfig` value is ignored.


		## Migration from OLM v0

		If you're migrating from OLM v0, you can directly transfer your `Subscription.spec.config` settings to the `deploymentConfig` object within `ClusterExtension.spec.config.inline`. The structure is identical.

	If you're migrating from OLM v0, you can directly transfer your `Subscription.spec.config` settings to the `deploymentConfig` object within `ClusterExtension.spec.config.inline`. The structure is identical.
	If you're migrating from OLM v0, the structure of the configuration fields is identical — simply nest your `Subscription.spec.config` settings under the `deploymentConfig` key within `ClusterExtension.spec.config.inline`.

Conversation

anik120 commented Feb 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Reviewer Checklist

Uh oh!

netlify bot commented Feb 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for olmv1 ready!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Feb 25, 2026

Choose a reason for hiding this comment

Uh oh!

perdasilva Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 25, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 25, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 25, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 25, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 25, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 25, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 25, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 25, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 25, 2026

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Feb 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

perdasilva Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

anik120 Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

perdasilva commented Mar 2, 2026

Uh oh!

perdasilva commented Mar 2, 2026

Uh oh!

anik120 commented Mar 2, 2026

Uh oh!

tmshort commented Mar 2, 2026

Uh oh!

openshift-ci bot commented Mar 2, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

anik120 commented Feb 25, 2026 •

edited

Loading

netlify bot commented Feb 25, 2026 •

edited

Loading

codecov bot commented Feb 25, 2026 •

edited

Loading